<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>IgH EtherCAT Master: fsm_foe.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">IgH EtherCAT Master
   &#160;<span id="projectnumber">1.5.2</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('fsm__foe_8h.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">fsm_foe.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>EtherCAT FoE state machines.  
<a href="#details">More...</a></p>

<p><a href="fsm__foe_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structec__fsm__foe.html">ec_fsm_foe</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Finite state machines for the CANopen-over-EtherCAT protocol.  <a href="structec__fsm__foe.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a67d256ed8586be0abb5c87691ad840f5"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structec__fsm__foe.html">ec_fsm_foe</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fsm__foe_8h.html#a67d256ed8586be0abb5c87691ad840f5">ec_fsm_foe_t</a></td></tr>
<tr class="separator:a67d256ed8586be0abb5c87691ad840f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:aeb7f396bcef5efd542597108eb9b1801"><td class="memItemLeft" align="right" valign="top"><a id="aeb7f396bcef5efd542597108eb9b1801"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fsm__foe_8h.html#aeb7f396bcef5efd542597108eb9b1801">ec_fsm_foe_init</a> (<a class="el" href="fsm__foe_8h.html#a67d256ed8586be0abb5c87691ad840f5">ec_fsm_foe_t</a> *)</td></tr>
<tr class="memdesc:aeb7f396bcef5efd542597108eb9b1801"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <br /></td></tr>
<tr class="separator:aeb7f396bcef5efd542597108eb9b1801"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abcbf9ea75475717789189556b74e96c8"><td class="memItemLeft" align="right" valign="top"><a id="abcbf9ea75475717789189556b74e96c8"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fsm__foe_8h.html#abcbf9ea75475717789189556b74e96c8">ec_fsm_foe_clear</a> (<a class="el" href="fsm__foe_8h.html#a67d256ed8586be0abb5c87691ad840f5">ec_fsm_foe_t</a> *)</td></tr>
<tr class="memdesc:abcbf9ea75475717789189556b74e96c8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <br /></td></tr>
<tr class="separator:abcbf9ea75475717789189556b74e96c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abf246a9d491ad93d1aa0a4abf71fd275"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fsm__foe_8h.html#abf246a9d491ad93d1aa0a4abf71fd275">ec_fsm_foe_exec</a> (<a class="el" href="fsm__foe_8h.html#a67d256ed8586be0abb5c87691ad840f5">ec_fsm_foe_t</a> *, <a class="el" href="structec__datagram__t.html">ec_datagram_t</a> *)</td></tr>
<tr class="memdesc:abf246a9d491ad93d1aa0a4abf71fd275"><td class="mdescLeft">&#160;</td><td class="mdescRight">Executes the current state of the state machine.  <a href="#abf246a9d491ad93d1aa0a4abf71fd275">More...</a><br /></td></tr>
<tr class="separator:abf246a9d491ad93d1aa0a4abf71fd275"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aabc5071b20cec133ec15cd8e9c062715"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fsm__foe_8h.html#aabc5071b20cec133ec15cd8e9c062715">ec_fsm_foe_success</a> (const <a class="el" href="fsm__foe_8h.html#a67d256ed8586be0abb5c87691ad840f5">ec_fsm_foe_t</a> *)</td></tr>
<tr class="memdesc:aabc5071b20cec133ec15cd8e9c062715"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns, if the state machine terminated with success.  <a href="#aabc5071b20cec133ec15cd8e9c062715">More...</a><br /></td></tr>
<tr class="separator:aabc5071b20cec133ec15cd8e9c062715"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac1a32ebc65651ecf94e5470c0108a1ed"><td class="memItemLeft" align="right" valign="top"><a id="ac1a32ebc65651ecf94e5470c0108a1ed"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fsm__foe_8h.html#ac1a32ebc65651ecf94e5470c0108a1ed">ec_fsm_foe_transfer</a> (<a class="el" href="fsm__foe_8h.html#a67d256ed8586be0abb5c87691ad840f5">ec_fsm_foe_t</a> *, <a class="el" href="globals_8h.html#a8d9ffff7dbe1babaa4786a63f2860d57">ec_slave_t</a> *, <a class="el" href="structec__foe__request__t.html">ec_foe_request_t</a> *)</td></tr>
<tr class="memdesc:ac1a32ebc65651ecf94e5470c0108a1ed"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prepares an FoE transfer. <br /></td></tr>
<tr class="separator:ac1a32ebc65651ecf94e5470c0108a1ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>EtherCAT FoE state machines. </p>

<p class="definition">Definition in file <a class="el" href="fsm__foe_8h_source.html">fsm_foe.h</a>.</p>
</div><h2 class="groupheader">Typedef Documentation</h2>
<a id="a67d256ed8586be0abb5c87691ad840f5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a67d256ed8586be0abb5c87691ad840f5">&#9670;&nbsp;</a></span>ec_fsm_foe_t</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef struct <a class="el" href="structec__fsm__foe.html">ec_fsm_foe</a> <a class="el" href="fsm__foe_8h.html#a67d256ed8586be0abb5c87691ad840f5">ec_fsm_foe_t</a></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="section see"><dt>See also</dt><dd><a class="el" href="structec__fsm__foe.html" title="Finite state machines for the CANopen-over-EtherCAT protocol. ">ec_fsm_foe</a> </dd></dl>

<p class="definition">Definition at line <a class="el" href="fsm__foe_8h_source.html#l00049">49</a> of file <a class="el" href="fsm__foe_8h_source.html">fsm_foe.h</a>.</p>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="abf246a9d491ad93d1aa0a4abf71fd275"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abf246a9d491ad93d1aa0a4abf71fd275">&#9670;&nbsp;</a></span>ec_fsm_foe_exec()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int ec_fsm_foe_exec </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="fsm__foe_8h.html#a67d256ed8586be0abb5c87691ad840f5">ec_fsm_foe_t</a> *&#160;</td>
          <td class="paramname"><em>fsm</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structec__datagram__t.html">ec_datagram_t</a> *&#160;</td>
          <td class="paramname"><em>datagram</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Executes the current state of the state machine. </p>
<dl class="section return"><dt>Returns</dt><dd>1, if the datagram was used, else 0. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">fsm</td><td>finite state machine </td></tr>
    <tr><td class="paramname">datagram</td><td>Datagram to use. </td></tr>
  </table>
  </dd>
</dl>

<p class="definition">Definition at line <a class="el" href="fsm__foe_8c_source.html#l00129">129</a> of file <a class="el" href="fsm__foe_8c_source.html">fsm_foe.c</a>.</p>

</div>
</div>
<a id="aabc5071b20cec133ec15cd8e9c062715"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aabc5071b20cec133ec15cd8e9c062715">&#9670;&nbsp;</a></span>ec_fsm_foe_success()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int ec_fsm_foe_success </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="fsm__foe_8h.html#a67d256ed8586be0abb5c87691ad840f5">ec_fsm_foe_t</a> *&#160;</td>
          <td class="paramname"><em>fsm</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns, if the state machine terminated with success. </p>
<dl class="section return"><dt>Returns</dt><dd>non-zero if successful. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">fsm</td><td>Finite state machine </td></tr>
  </table>
  </dd>
</dl>

<p class="definition">Definition at line <a class="el" href="fsm__foe_8c_source.html#l00163">163</a> of file <a class="el" href="fsm__foe_8c_source.html">fsm_foe.c</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="dir_c1346cf4828efdd0d2baf0d391d01b77.html">master</a></li><li class="navelem"><a class="el" href="fsm__foe_8h.html">fsm_foe.h</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
  </ul>
</div>
</body>
</html>
